Skip to content

Conversation

@fingolfin
Copy link
Member

@fingolfin fingolfin commented Oct 28, 2025

In Markdown, links are written as [desc](URL), and no space is allowed between ] and (. However, Julia's Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown implementations seems more important to me; it is very surprising when one copies basic Markdown that works fine elsewhere into a Julia package manual and it suddenly is treated completely differently.

Resolves JuliaDocs/Documenter.jl#2538
Resolves JuliaDocs/Documenter.jl#2681

In Markdown, links are written as `[desc](URL)`, and no
space is allowed between `]` and `(`. However, Julia's
Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix
will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown
implementations seems more important to me; it is very
surprising when one copies basic Markdown that works fine
elsewhere into a Julia package manual and it suddenly is
treated completely differently.

Resolves JuliaDocs/Documenter.jl#2681
Copy link
Member

@tecosaur tecosaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems eminently sane to me.

@tecosaur
Copy link
Member

tecosaur commented Nov 7, 2025

The test failure is in GC, and clearly spurious.

@tecosaur tecosaur merged commit fe30573 into master Nov 7, 2025
8 of 10 checks passed
@tecosaur tecosaur deleted the mh/markdown-links branch November 7, 2025 10:09
@fingolfin fingolfin added backport 1.13 backport 1.12 Change should be backported to release-1.12 labels Nov 7, 2025
KristofferC pushed a commit that referenced this pull request Nov 8, 2025
In Markdown, links are written as `[desc](URL)`, and no
space is allowed between `]` and `(`. However, Julia's
Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix
will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown
implementations seems more important to me; it is very
surprising when one copies basic Markdown that works fine
elsewhere into a Julia package manual and it suddenly is
treated completely differently.

Resolves JuliaDocs/Documenter.jl#2681

(cherry picked from commit fe30573)
KristofferC pushed a commit that referenced this pull request Nov 8, 2025
In Markdown, links are written as `[desc](URL)`, and no
space is allowed between `]` and `(`. However, Julia's
Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix
will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown
implementations seems more important to me; it is very
surprising when one copies basic Markdown that works fine
elsewhere into a Julia package manual and it suddenly is
treated completely differently.

Resolves JuliaDocs/Documenter.jl#2681

(cherry picked from commit fe30573)
KristofferC pushed a commit that referenced this pull request Nov 10, 2025
In Markdown, links are written as `[desc](URL)`, and no
space is allowed between `]` and `(`. However, Julia's
Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix
will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown
implementations seems more important to me; it is very
surprising when one copies basic Markdown that works fine
elsewhere into a Julia package manual and it suddenly is
treated completely differently.

Resolves JuliaDocs/Documenter.jl#2681

(cherry picked from commit fe30573)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 1.12 Change should be backported to release-1.12 backport 1.13 markdown

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs erroneously parse a phrase [something] (something else) as markdown link Incorrectly interpreting square brackets in docstrings as links

3 participants